<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<html lang="en-us" xml:lang="en-us">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="DC.Type" content="topic">
  <meta name="DC.Title" content="Step 1: Registering a MongoDB Cluster">
  <meta name="product" content="">
  <meta name="DC.Relation" scheme="URI" content="en-us_topic_0000001792389416.html">
  <meta name="prodname" content="">
  <meta name="version" content="">
  <meta name="brand" content="30-OceanProtect Appliance 1.5.0-1.6.0 Help Center">
  <meta name="DC.Publisher" content="20240608">
  <meta name="DC.Format" content="XHTML">
  <meta name="DC.Identifier" content="EN-US_TOPIC_0000001839188513">
  <meta name="DC.Language" content="en-us">
  <link rel="stylesheet" type="text/css" href="public_sys-resources/commonltr.css">
  <title>Step 1: Registering a MongoDB Cluster</title>
 </head>
 <body style="clear:both; padding-left:10px; padding-top:5px; padding-right:5px; padding-bottom:5px">
  <a name="EN-US_TOPIC_0000001839188513"></a><a name="EN-US_TOPIC_0000001839188513"></a>
  <h1 class="topictitle1">Step 1: Registering a MongoDB Cluster</h1>
  <div>
   <div class="section">
    <h4 class="sectiontitle">Prerequisites</h4>
    <p>Before registering a MongoDB cluster, ensure that each host in the cluster has been registered.</p>
   </div>
   <div class="section">
    <h4 class="sectiontitle">Procedure</h4>
    <ol>
     <li><span>Choose <span class="uicontrol" id="EN-US_TOPIC_0000001839188513__en-us_topic_0000001839142377_uicontrol9332164373910"><b><span id="EN-US_TOPIC_0000001839188513__en-us_topic_0000001839142377_text11332943123919"><strong>Protection</strong></span> &gt; Big Data &gt; MongoDB</b></span>.</span></li>
     <li><span>Click <span class="uicontrol"><b><span><strong>Register</strong></span></b></span> to register the MongoDB cluster.</span></li>
     <li><span>Select a cluster type in the <strong>Register</strong> dialog box.</span><p></p>
      <ul>
       <li>Single instance
        <ol type="a">
         <li>Configure the database instance and its authentication information.<p><a href="#EN-US_TOPIC_0000001839188513__en-us_topic_0000001311214069_table241515964115">Table 1</a> describes the related parameters.</p>
          <div class="tablenoborder">
           <a name="EN-US_TOPIC_0000001839188513__en-us_topic_0000001311214069_table241515964115"></a><a name="en-us_topic_0000001311214069_table241515964115"></a>
           <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001839188513__en-us_topic_0000001311214069_table241515964115" frame="border" border="1" rules="all">
            <caption>
             <b>Table 1 </b>Registration information of a single MongoDB instance
            </caption>
            <colgroup>
             <col style="width:25.629999999999995%">
             <col style="width:74.37%">
            </colgroup>
            <thead align="left">
             <tr>
              <th align="left" class="cellrowborder" valign="top" width="25.629999999999995%" id="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1"><p>Parameter</p></th>
              <th align="left" class="cellrowborder" valign="top" width="74.37%" id="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2"><p>Description</p></th>
             </tr>
            </thead>
            <tbody>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Name</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Instance name.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Hosts</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Select the database host to be registered.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Port</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Port number of the MongoDB instance.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Authentication Method</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>The instance authentication mode can be OS authentication or database authentication.</p>
               <ul>
                <li>OS authentication: authentication based on the OS.</li>
                <li>Database authentication: authentication through the database administrator username and password.</li>
               </ul></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Database Username</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Name of the database administrator. This parameter is displayed only when authentication mode is set to database authentication.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Database Password</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Password of the database administrator. This parameter is displayed only when authentication mode is set to database authentication.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Database Installation Directory</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Set this parameter to the directory where the <strong>mongo</strong>/<strong>mongod</strong>/<strong>mongos</strong> file is located. If this parameter is not specified, the directory configured in the global variable is used by default.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.1 "><p><span><strong>Database Tool Installation Directory</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.1.1.1.2.2.3.1.2 "><p>Set this parameter to the directory where the <strong>mongodump/mongorestore</strong> tool is located. If this parameter is not specified, the tool directory configured in the global variable is used by default.</p></td>
             </tr>
            </tbody>
           </table>
          </div></li>
         <li>Click <span class="uicontrol"><b>OK</b></span>.</li>
        </ol></li>
       <li>Cluster instance
        <ol type="a">
         <li>Customize the instance name and select a cluster type, which can be <strong>Replica set</strong> or <strong>Sharded</strong>.</li>
         <li>(Optional) Configure the data installation directory or the database tool installation directory in batches. After the configuration is complete, you can configure the database installation directory or database tool installation directory for all added nodes.</li>
         <li>Click <strong>Add</strong>. In the <strong>Add</strong> dialog box, add all nodes of the cluster instance.<p><a href="#EN-US_TOPIC_0000001839188513__table935220207402">Table 2</a> describes the related parameters.</p>
          <div class="tablenoborder">
           <a name="EN-US_TOPIC_0000001839188513__table935220207402"></a><a name="table935220207402"></a>
           <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001839188513__table935220207402" frame="border" border="1" rules="all">
            <caption>
             <b>Table 2 </b>Node information of a MongoDB cluster instance
            </caption>
            <colgroup>
             <col style="width:25.629999999999995%">
             <col style="width:74.37%">
            </colgroup>
            <thead align="left">
             <tr>
              <th align="left" class="cellrowborder" valign="top" width="25.629999999999995%" id="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1"><p>Parameter</p></th>
              <th align="left" class="cellrowborder" valign="top" width="74.37%" id="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2"><p>Description</p></th>
             </tr>
            </thead>
            <tbody>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Hosts</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>Select the database host to be registered.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Port</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>MongoDB port number.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Authentication Method</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>The instance authentication mode can be OS authentication or database authentication.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Database Username</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>Name of the database administrator. This parameter is displayed only when authentication mode is set to database authentication.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Database Password</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>Password of the database administrator. This parameter is displayed only when authentication mode is set to database authentication.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Database Installation Directory</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>Set this parameter to the directory where the <strong>mongo</strong>/<strong>mongod</strong>/<strong>mongos</strong> file is located. If this parameter is not specified, the directory configured in the global variable is used by default.</p></td>
             </tr>
             <tr>
              <td class="cellrowborder" valign="top" width="25.629999999999995%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.1 "><p><span><strong>Database Tool Installation Directory</strong></span></p></td>
              <td class="cellrowborder" valign="top" width="74.37%" headers="mcps1.3.2.2.3.2.1.2.1.3.4.2.3.1.2 "><p>Set this parameter to the directory where the <strong>mongodump/mongorestore</strong> tool is located. If this parameter is not specified, the tool directory configured in the global variable is used by default.</p></td>
             </tr>
            </tbody>
           </table>
          </div></li>
         <li>Click <span class="uicontrol"><b>OK</b></span>.</li>
        </ol></li>
      </ul> <p></p></li>
    </ol>
   </div>
  </div>
  <div>
   <div class="familylinks">
    <div class="parentlink">
     <strong>Parent topic:</strong> <a href="en-us_topic_0000001792389416.html">Backing Up MongoDB Databases</a>
    </div>
   </div>
  </div>
 </body>
</html>